Resource Path: /api/job/doc/{id}
Uri: http://doc.jamsscheduler.com/api/job/doc/{id}
Description
Get the Documentation for a given Job by name.
Parameters
| Name | Description | Data Type |
|---|
| id | The Job ID | integer |
| doctype | Documentation Type | string |
| rendertype | Render Type | string |
Response
The response body is of type Job.
OK
Overview
 |
Job
 |
description : string
|
 |
|
elementName : string
|
|
elementTypeName : string
|
|
elementTypeId : integer
|
|
elementId : integer
|
|
elementUid : string
|
|
ownerUid : string
|
|
inherited : boolean
|
|
inheritedFromType : string
|
|
inheritedFromId : integer
|
|
inheritedFromName : string
|
|
elementKind : string
|
|
elementState : string
|
|
|
propertyName : string
|
|
categoryName : string
|
|
categorySortOrder : integer
|
|
displayName : string
|
|
propertyId : integer
|
|
typeName : string
|
|
typeNameSSO : string
|
|
toolTip : string
|
|
description : string
|
|
editor : string
|
|
mergeOption : string
|
|
sortOrder : integer
|
|
inheritedFromType : string
|
|
inheritedFromId : integer
|
|
inheritedFromName : string
|
|
readOnly : boolean
|
|
browsable : boolean
|
|
defaultValue : object
|
|
currentValue : object
|
|
|
writeToEntry : boolean
|
|
writeToHistory : boolean
|
|
tabName : string
|
|
sortOrder : integer
|
|
validateTypeNameSSO : string
|
|
formatString : string
|
|
addMenuText : string
|
|
categoryName : string
|
|
categoryAddMenuText : string
|
|
categorySortOrder : integer
|
|
|
|
elementName : string
|
|
elementTypeName : string
|
|
elementTypeId : integer
|
|
elementId : integer
|
|
elementUid : string
|
|
ownerUid : string
|
|
inherited : boolean
|
|
inheritedFromType : string
|
|
inheritedFromId : integer
|
|
inheritedFromName : string
|
|
elementKind : string
|
|
elementState : string
|
|
|
propertyName : string
|
|
categoryName : string
|
|
categorySortOrder : integer
|
|
displayName : string
|
|
propertyId : integer
|
|
typeName : string
|
|
typeNameSSO : string
|
|
toolTip : string
|
|
description : string
|
|
editor : string
|
|
mergeOption : string
|
|
sortOrder : integer
|
|
inheritedFromType : string
|
|
inheritedFromId : integer
|
|
inheritedFromName : string
|
|
readOnly : boolean
|
|
browsable : boolean
|
|
defaultValue : object
|
|
currentValue : object
|
|
|
writeToEntry : boolean
|
|
writeToHistory : boolean
|
|
tabName : string
|
|
sortOrder : integer
|
|
validateTypeNameSSO : string
|
|
formatString : string
|
|
addMenuText : string
|
|
categoryName : string
|
|
categoryAddMenuText : string
|
|
categorySortOrder : integer
|
|
|
jobID : integer
|
|
jobName : string
|
|
qualifiedName : string
|
|
parameters : Array[Param]
|
allowEntry : boolean
|
|
dataType : string
|
|
defaultFormat : string
|
|
defaultValue : string
|
|
encrypt : boolean
|
|
helpText : string
|
|
hide : boolean
|
|
inherited : boolean
|
|
jobID : integer
|
|
lastChangeUTC : string
|
|
length : integer
|
|
mustFill : boolean
|
|
parameterOrigin : string
|
|
paramId : integer
|
|
paramName : string
|
|
prompt : string
|
|
required : boolean
|
|
sequence : integer
|
|
uppercase : boolean
|
|
validationData : string
|
|
validationType : string
|
|
variableID : integer
|
|
variableName : string
|
|
variableNameIsRelative : boolean
|
|
|
propertyName : string
|
|
categoryName : string
|
|
categorySortOrder : integer
|
|
displayName : string
|
|
propertyId : integer
|
|
typeName : string
|
|
typeNameSSO : string
|
|
toolTip : string
|
|
description : string
|
|
editor : string
|
|
mergeOption : string
|
|
sortOrder : integer
|
|
inheritedFromType : string
|
|
inheritedFromId : integer
|
|
inheritedFromName : string
|
|
readOnly : boolean
|
|
browsable : boolean
|
|
defaultValue : object
|
|
currentValue : object
|
|
|
encryptionId : integer
|
|
newEncryptedValue : string
|
|
|
|
propertyName : string
|
|
categoryName : string
|
|
categorySortOrder : integer
|
|
displayName : string
|
|
propertyId : integer
|
|
typeName : string
|
|
typeNameSSO : string
|
|
toolTip : string
|
|
description : string
|
|
editor : string
|
|
mergeOption : string
|
|
sortOrder : integer
|
|
inheritedFromType : string
|
|
inheritedFromId : integer
|
|
inheritedFromName : string
|
|
readOnly : boolean
|
|
browsable : boolean
|
|
defaultValue : object
|
|
currentValue : object
|
|
|
source : string
|
|
methodID : integer
|
|
methodName : string
|
|
lastChangeUTC : string
|
|
lastChangedBy : string
|
|
parentFolderID : integer
|
|
parentFolderName : string
|
|
maxBufferedIOCount : integer
|
|
maxDirectIOCount : integer
|
|
maxWorkingSetPeak : integer
|
|
maxPageFaults : integer
|
 |
|
totalSeconds : integer
|
|
|
|
totalSeconds : integer
|
|
|
maxCount : integer
|
|
minDirectIOCount : integer
|
|
minBufferedIOCount : integer
|
|
minWorkingSetPeak : integer
|
|
minPageFaults : integer
|
|
|
totalSeconds : integer
|
|
|
|
totalSeconds : integer
|
|
|
lastAutosubmitUTC : string
|
|
minCount : integer
|
|
avgPageFaults : integer
|
|
|
totalSeconds : integer
|
|
|
|
totalSeconds : integer
|
|
|
avgCount : integer
|
|
avgWorkingSetPeak : integer
|
|
lastFatalUTC : string
|
|
lastErrorUTC : string
|
|
lastWarningUTC : string
|
|
lastResetUTC : string
|
|
lastSuccessUTC : string
|
|
lastInfoUTC : string
|
|
avgBufferedIOCount : integer
|
|
avgDirectIOCount : integer
|
 |
tagIds : Array[]
|
|
|
tagId : integer
|
|
tagName : string
|
|
|
inheritedTagIds : Array[]
|
|
|
|
identifier : string
|
|
inherited : boolean
|
|
flags : string
|
|
accessList : Array[string]
|
|
|
|
See Also